dac24.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef DAC24_H
#define DAC24_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"




#define DAC24_REG_POWER_DOWN_100K               0x00
#define DAC24_REG_AO1_DATA_OUT                  0x01
#define DAC24_REG_AO2_DATA_OUT                  0x02
#define DAC24_REG_AO3_DATA_OUT                  0x03
#define DAC24_REG_ALL_CH_DATA_OUT               0x07
#define DAC24_REG_POWER_DOWN_2_5K               0x08
#define DAC24_REG_AO1_DATA                      0x09
#define DAC24_REG_AO2_DATA                      0x0A
#define DAC24_REG_AO3_DATA                      0x0B
#define DAC24_REG_POWER_DOWN_HIZ                0x0F
 // dac24_reg



#define DAC24_CHANNEL_ALL                       0
#define DAC24_CHANNEL_1                         1
#define DAC24_CHANNEL_2                         2
#define DAC24_CHANNEL_3                         3

#define DAC24_POWER_DOWN_HIZ                    0
#define DAC24_POWER_DOWN_2_5K                   1
#define DAC24_POWER_DOWN_100K                   2

#define DAC24_DAC_VALUE_MIN                     0x00
#define DAC24_DAC_VALUE_MID                     0x80
#define DAC24_DAC_VALUE_MAX                     0xFF

#define DAC24_VCC_3V3                           3300
#define DAC24_VCC_5V                            5000
#define DAC24_VCC_LEVEL                         DAC24_VCC_3V3

#define DAC24_SET_DATA_SAMPLE_EDGE              SET_SPI_DATA_SAMPLE_EDGE
#define DAC24_SET_DATA_SAMPLE_MIDDLE            SET_SPI_DATA_SAMPLE_MIDDLE
 // dac24_set



#define DAC24_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS );
 // dac24_map // dac24

typedef struct
{
    // Modules
    spi_master_t spi;           
 
    pin_name_t   chip_select;   
 
} dac24_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t miso;            
    pin_name_t mosi;            
    pin_name_t sck;             
    pin_name_t cs;              
 
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
 
} dac24_cfg_t;

typedef enum
{
    DAC24_OK = 0,
    DAC24_ERROR = -1
 
} dac24_return_value_t;


void dac24_cfg_setup ( dac24_cfg_t *cfg );

err_t dac24_init ( dac24_t *ctx, dac24_cfg_t *cfg );

err_t dac24_write_reg ( dac24_t *ctx, uint8_t reg, uint8_t data_in );

err_t dac24_set_power_down ( dac24_t *ctx, uint8_t pwr );

err_t dac24_set_dac_value ( dac24_t *ctx, uint8_t channel, uint8_t value );

err_t dac24_set_dac_voltage ( dac24_t *ctx, uint8_t channel, uint16_t voltage_mv );
 
#ifdef __cplusplus
}
#endif
#endif // DAC24_H
 // dac24
 
// ------------------------------------------------------------------------ END